{"id":11568,"date":"2017-08-08T12:06:31","date_gmt":"2017-08-08T16:06:31","guid":{"rendered":"https:\/\/www.gravityhelp.com\/?p=11568"},"modified":"2019-10-01T19:34:08","modified_gmt":"2019-10-01T23:34:08","slug":"gravity-forms-rest-api-v2-rc1-released","status":"publish","type":"post","link":"https:\/\/www.gravityforms.com\/blog\/gravity-forms-rest-api-v2-rc1-released\/","title":{"rendered":"Gravity Forms REST API v2 RC1 Released"},"content":{"rendered":"

The Gravity Forms REST API version 2.0-rc-1 is now available on the downloads<\/a> page. This a developer-focused, feature plugin which contains\u00a0version 2 of the current\u00a0Web\/REST API.<\/a>\u00a0It will soon be added to the Gravity Forms core so we encourage developers to give their feedback now.
\n<\/p>\n

The aim\u00a0of version 2 is\u00a0to dovetail with the WordPress REST API in terms of routing, discovery, authentication, usage,\u00a0extensibility and best practices. It also\u00a0provides the solid foundation we need for the development of future versions of Gravity Forms and add-ons.<\/p>\n

Version 2 will work alongside\u00a0version 1\u00a0but users will have the option to turn off version 1. Support for version 1 will be phased out so it’s very important that\u00a0developers begin\u00a0adding support for version 2 now.<\/p>\n

Please send all your bug reports, questions and comments\u00a0by opening a support ticket<\/a>.\u00a0The development version of the plugin can be found in the public repository<\/a> on GitHub.<\/p>\n

Upgrading to Version 2<\/h2>\n

The API is intended to feel as familiar as possible to developers who have worked with the WordPress REST API. The endpoints are largely the same as version 1, however, the responses are slightly different and authentication is no longer handled by Gravity Forms.<\/p>\n

The following breaking changes<\/strong> are required by clients to consume version 2:<\/p>\n

Content-Type<\/h3>\n

The API accepts both standard form fields and JSON content types. When sending JSON, the content-type request header must be set to “application\/json”. If the content-type is omitted then the request will be interpreted as “application\/x-www-form-urlencoded”.<\/p>\n

<\/a><\/a>No Response Envelope<\/h3>\n

The response will not be enveloped by default as in version 1. This means that the response will not be a JSON string containing the “status” and “response” – the body will contain the response and the HTTP code will contain the status code.<\/p>\n

The WP-API will add an envelope to the response if the _envelope<\/em> parameter is included in the request.<\/p>\n

<\/a>Authentication<\/h3>\n

Authentication is now\u00a0no longer handled by Gravity Forms.<\/p>\n

If you’re using cookie authentication, WordPress supports cookie authentication out of the box so you’ll just need
\nto change the way the nonce is created and sent. Create the nonce using wp_create_nonce( ‘wp_rest’ ) and send it
\nin the _wpnonce data parameter (either POST data or in the query for GET requests), or via the X-WP-Nonce header.<\/p>\n

The signature authentication used in version 1 has been removed in version 2. If you’re using signature authentication then you’ll need to implement either Basic or OAuth authentication for the WordPress REST API. Further details here:<\/p>\n

WordPress REST API authentication documentation<\/a>
\nWP REST API: Setting Up and Using Basic Authentication<\/a>
\nWP REST API: Setting Up and Using OAuth 1.0a Authentication<\/a><\/p>\n

<\/a>Form Submissions<\/h3>\n

The Form Submissions endpoint now accepts application\/json, application\/x-www-form-urlencoded and multipart\/form-data content types. With the introduction of support for the multipart\/form-data content type files can be sent to single file upload fields.<\/p>\n

Request values should be sent all together instead of in separate elements for input_values, field_values, target_page and source_page.<\/p>\n

Example body of a JSON form submission:<\/strong><\/p>\n

\n
{\r\n    \"<\/span>input_1\"<\/span><\/span>: \"<\/span>test\"<\/span><\/span>,\r\n    \"<\/span>field_values\"<\/span><\/span> : \"<\/span>\"<\/span><\/span>,\r\n    \"<\/span>source_page\"<\/span><\/span>: 1<\/span>,\r\n    \"<\/span>target_page\"<\/span><\/span>: 0<\/span>\r\n}<\/code><\/pre>\n<\/div>\n
<\/a>POST Single Resources<\/h3>\n
In order to maintain consistency with the WP API, the POST \/entries and POST \/forms endpoints no longer accept collections. This means that it’s no longer possible to create multiple entries or forms in a single request.<\/p>\n
 <\/p>\n
For further technical details, check out the readme.md file in the plugin folder.<\/p>\n
REST API Add-On v2.0 Changelog<\/h2>\n